Auction examples
- Running auctions
- Sponsored listings
- Sponsored banners
- Sponsored brands
Asset examples
Webhook examples
Toptimize
Assets API
Billing API
- GETGet Billing Contacts
- GETGet Billing Contact
- PUTUpsert Billing Contact
- GETGet Campaign Billing Contact
- PUTUpsert Campaign Billing Contact
- GETGet Marketplace Credit Limit
- POSTSet Marketplace Credit Limit
- PUTUpsert Vendor Billing Contact
- GETGet Vendor Charges
- GETGet Vendor Account Activity
- GETGet Vendor Balance
- POSTAdd Vendor Balance
- POSTBurn Vendor Balance
- GETGet Vendor Credit History
- GETGet Vendor Credit Limit
- POSTSet Vendor Credit Limit
- DELDelete Vendor Billing Contact
- GETGet Vendor Wallets
- POSTCreate Wallet
- POSTAdjust Wallet Balance
Campaign API
- GETGet Campaigns
- POSTCreate Campaign
- GETGet Campaign By Id
- DELDelete Campaign By Id
- PATCHUpdate Campaign By Id
- GETGet Campaign Bids
- POSTCreate Campaign Bids
- DELDelete Campaign Bid By Id
- PATCHUpdate Campaign Bid By Id
- POST[BETA] Get estimated clicks of a future campaign for a given vendor
- GETGet Products In Campaign
- GETGet Sponsored Products
Catalog API
Invitation API
Modal API
Reporting API
- GETGet Campaign Report
- GETGet Campaign Daily Report
- GETGet Campaign Report By Product
- GETGet Product Report
- GETGet Product Daily Report
- GETGet Marketplace Interactions Report
- GETGet Marketplace Report
- GETGet Marketplace Campaigns Kpis
- GETGet Marketplace Daily Report
- GETGet Marketplace Vendors Kpis
- GETGet Vendor Report
- GETGet Vendor Daily Report
Segments Service
Toppie API
- GET[BETA] Get Agency Account Balance
- GET[BETA] Get Agency Account Top-ups
- GET[BETA] Get Toppie Campaigns
- POST[BETA] Create Toppie Campaign
- GET[BETA] Get Toppie Campaign Details
- PATCH[BETA] Update Toppie Campaign
- GET[BETA] Get Toppie Campaign Bids
- GETList Account Products
- GETGet Agency Account Report
- GETGet Agency Account Activity
- GETGet Agency Account Campaigns
- GETGet Account Campaigns By Ids
- GETGet Agency Campaign Report
- GETGet Campaign Report Per Product
[BETA] Get Toppie Campaigns
Retrieve a list of campaigns associated with a specific account.
curl --request GET \
--url https://api.topsort.com/public/v1/toppie/campaigns
{
"campaigns": [
{
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"adFormat": "listing",
"bidCount": 123,
"budget": 123,
"budgetPeriod": "daily",
"chargeType": "CPM",
"createdAt": "2023-11-07T05:31:56Z",
"currencyCode": "USD",
"endDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isActive": true,
"name": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"targetRoas": 10.25
}
],
"hasMore": true,
"nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}
Query Parameters
Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.
Limit of accounts to retrieve.
0 < x <= 100
Response
List of campaigns that belong to the agency
Represents a public version of an agency campaign, used in API responses.
Account that owns this campaign
The ads format for this campaign (only listing is currently supported)
listing
, banner
, exclusive_listing
, travel_listing
, flight_listing
Total budget for this campaign
The periodicity of the budget
daily
, weekly
, monthly
, total
The charge type for this campaign
CPM
, CPC
, CPA
Date and time when the campaign was created
Currency code this campaign is working with in ISO 4217 format
"USD"
Internal identifier for the agency campaign
Flag to indicate if the campaign is active or not
Campaign name
Target ROAS for the campaign
0.5 <= x <= 20
Bid count for the campaign (optional)
Date when to stop the campaign, specified in RFC 3339, if not set the campaign will never stop. This date must be greater than the start date and must be in the future. Must include the Timezone definition.
Flag that indicates whether more results are available. true
indicates there is a next page of results. false
indicates this response contains the last page of results.
Pagination cursor. Provide this value as a next_page
query parameter in a new request to retrieve the next page of results.
1
"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
curl --request GET \
--url https://api.topsort.com/public/v1/toppie/campaigns
{
"campaigns": [
{
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"adFormat": "listing",
"bidCount": 123,
"budget": 123,
"budgetPeriod": "daily",
"chargeType": "CPM",
"createdAt": "2023-11-07T05:31:56Z",
"currencyCode": "USD",
"endDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isActive": true,
"name": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"targetRoas": 10.25
}
],
"hasMore": true,
"nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}